docs: improve README organization and clarity #941
Conversation
GarmashAlex
commented
Jan 16, 2025
GarmashAlex
commented
- Update TGE announcement styling for better visibility
- Add concise overview of Linea features
- Create Quick Links section for easy navigation
- Reorganize contribution guidelines
- Improve formatting and readability
- Update ecosystem contributor guidelines
- Add emojis for better visual organization
- Update TGE announcement styling for better visibility - Add concise overview of Linea features - Create Quick Links section for easy navigation - Reorganize contribution guidelines - Improve formatting and readability - Update ecosystem contributor guidelines - Add emojis for better visual organization
|
@GarmashAlex is attempting to deploy a commit to the Consensys Team on Vercel. A member of the Team first needs to authorize it. |
|
thanks for contributing @GarmashAlex. I appreciate that the goal here was to make the README clearer and simpler, but I think it results in dropping a lot of detail in the process, and we need to retain that detail, so I'll be closing. I'm not sure all the changes were strictly necessary, either — the quick links section could be useful, but again, I'm not sure the README is crying out for it. A more minor point is that some of your suggestions conflict with our style — e.g. using title case for headings (we use sentence case) and correcting e.g. "Contribute" to "Contributing [...]" (we use imperatives for headings). Some of this is covered in the Consensys docs style guide linked in the README. |
